| Package | hl7.v2plus | |||||||||||||||||||||||||||||||||||||||||||
| Type | StructureDefinition | |||||||||||||||||||||||||||||||||||||||||||
| Id | Id | |||||||||||||||||||||||||||||||||||||||||||
| FHIR Version | R5 | |||||||||||||||||||||||||||||||||||||||||||
| Source | http://somewhere.org/fhir/uv/v2plus/https://build.fhir.org/ig/HL7/v2ig/StructureDefinition-XPN.html | |||||||||||||||||||||||||||||||||||||||||||
| Url | http://hl7.org/v2/StructureDefinition/XPN | |||||||||||||||||||||||||||||||||||||||||||
| Version | 0.0.0 | |||||||||||||||||||||||||||||||||||||||||||
| Status | active | |||||||||||||||||||||||||||||||||||||||||||
| Date | 2024-11-08T13:58:48+00:00 | |||||||||||||||||||||||||||||||||||||||||||
| Name | XPN | |||||||||||||||||||||||||||||||||||||||||||
| Title | HL7 v2 XPN Data Type | |||||||||||||||||||||||||||||||||||||||||||
| Experimental | False | |||||||||||||||||||||||||||||||||||||||||||
| Authority | hl7 | |||||||||||||||||||||||||||||||||||||||||||
| Description | *Note:* Replaces PN data type as of v 2.3.
*Internationalization Note:* In countries using ideographic or syllabic (phonetic) character sets, it is sometimes necessary to send the name in one or both of these formats, as well as an alphabetic format. The switching between the different character sets can be accomplished using a character set such as JIS X 0202 - ISO 2022 which provides an escape sequence for switching among different character sets and among single-byte and multi-byte character representations. When the name field is repeated, the different repetitions of the name may be represented by these different character sets. The details are as follows. (See also Section 2.9.2, “Escape sequences supporting multiple character sets for PN, XPN, XCN, XON, XAD, FT, ST and TX data types.”)
HL7 supports the following standards for Japanese characters:
JIS X 0201 for ISO-IR 13 (Japanese Katakana)
JIS X 0201 for ISO-IR 14 (Japanese Romaji)
JIS X 0208 for ISO-IR 87 (Japanese Kanji, Hiragana and Katakana)
JIS X 0212 for ISO-IR 159 (supplementary Japanese Kanji)
HL7 supports the following standards for European characters:
ISO 8859 (1-9) for ISO-IR 100, 101, 109, 110, 144,127, 126, 138 and 148.
Character sets are referenced in HL7 as ASCII, 8859/1,8859/2, ISO IR14, ISO IR87, and ISO IR159. DICOM uses codes laid out in ISO 2375, of the form 'ISO-IR xxx'. HL7 supports this naming as well, to facilitate interoperability.
HL7 uses the Basic G0 Set of the International Reference Version of ISO 646:1990 (ISO IR-6) as the default character repertoire for character strings. This is a single-byte character set, identical to ASCII.
Each repetition of a XPN, XON, XCN, or XAD field is assumed to begin with the default character set. If another character set is to be used, the HL7 defined escape sequence used to announce that character set must be at the beginning of the repetition, and the HL7 defined escape sequence used to start the default character set must be at the end of the repetition. Note also that several character sets may be intermixed within a single repetition as long as the repetition ends with a return to the default character set.
An application must specify which character sets it supports in the field _MSH-18 Character Sets_ and which character set handling scheme it supports in the field _MSH-20 Alternate Character Set Handling Scheme_. It is assumed that the sending and receiving applications are aware of how to map character set names (i.e., ISO-IR xxx) to escape sequences.
For example, in many Japanese messages there is a mix of Romaji (i.e., Roman characters), Katakana (phonetic representation of foreign words), Hiragana (phonetic representation of Japanese words) and Kanji (pictographs). Such a message would require 4 character sets be specified in the MSH.
References for Internationalization of Name
| |||||||||||||||||||||||||||||||||||||||||||
| Type | http://hl7.org/v2/StructureDefinition/XPN | |||||||||||||||||||||||||||||||||||||||||||
| Kind | logical |
No resources found
| StructureDefinition | |
http://hl7.org/v2/StructureDefinition/CWE  | HL7 v2 CWE Data Type |
| http://hl7.org/v2/StructureDefinition/DTM | HL7 v2 DTM Data Type |
| http://hl7.org/v2/StructureDefinition/FN | HL7 v2 FN Data Type |
| http://hl7.org/v2/StructureDefinition/ID | HL7 v2 ID Data Type |
| http://hl7.org/v2/StructureDefinition/ST | HL7 v2 String Primitive Type |
| http://hl7.org/v2/StructureDefinition/v2-complex-data-type | HL7 v2 Complex Data Type |
| http://terminology.hl7.org/ValueSet/v2-0200 | hl7VS-nameType |
| http://terminology.hl7.org/ValueSet/v2-0444 | hl7VS-nameAssemblyOrder |
| http://terminology.hl7.org/ValueSet/v2-0465 | hl7VS-name-addressRepresentation |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition XPN
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  XPN | 0..* | V2ComplexDataType | extended person name Instances of this logical model are not marked to be the target of a Reference | |
  1 | 1..1 | FN | Family Name | |
 2 | 0..1 | string | Given Name | |
| 3 | 0..1 | string | Second and Further Given Names or Initials Thereof | |
| 4 | 0..1 | string | Suffix | |
| 5 | 0..1 | string | Prefix | |
| 6 | Degree | |||
| 7 | 0..1 | code | Name Type Code Binding: hl7VS-nameType (required) | |
| 8 | 0..1 | code | Name Representation Code Binding: hl7VS-name-addressRepresentation (required) | |
| 9 | 0..1 | CWE | Name Context Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required) | |
| 10 | Name Validity Range | |||
| 11 | 0..1 | code | Name Assembly Order Binding: hl7VS-nameAssemblyOrder (required) | |
| 12 | 0..1 | dateTime | Effective Date | |
| 13 | 0..1 | dateTime | Expiration Date | |
| 14 | 0..1 | string | Professional Suffix | |
 15 | 0..1 | string | Called By | |
| Documentation for this format | ||||
FHIR{
"resourceType" : "StructureDefinition",
"id" : "XPN",
"meta" : {
"profile" : [
"http://hl7.org/v2/StructureDefinition/ComplexDataType-Profile"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition XPN</b></p><a name=\"XPN\"> </a><a name=\"hcXPN\"> </a><a name=\"XPN-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN\">XPN</a><a name=\"XPN\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-v2-complex-data-type.html\">V2ComplexDataType</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">extended person name<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span><br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.1\">1</a><a name=\"XPN.1\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-FN.html\">FN</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Family Name</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.2\">2</a><a name=\"XPN.2\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Given Name</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.3\">3</a><a name=\"XPN.3\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Second and Further Given Names or Initials Thereof</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.4\">4</a><a name=\"XPN.4\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Suffix</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.5\">5</a><a name=\"XPN.5\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Prefix</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.6\">6</a><a name=\"XPN.6\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Degree</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.7\">7</a><a name=\"XPN.7\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ID.html\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Name Type Code<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"http://terminology.hl7.org/6.0.2/ValueSet-v2-0200.html\" title=\"http://terminology.hl7.org/ValueSet/v2-0200\">hl7VS-nameType</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.8\">8</a><a name=\"XPN.8\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ID.html\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Name Representation Code<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"http://terminology.hl7.org/6.0.2/ValueSet-v2-0465.html\" title=\"http://terminology.hl7.org/ValueSet/v2-0465\">hl7VS-name-addressRepresentation</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.9\">9</a><a name=\"XPN.9\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-CWE.html\">CWE</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Name Context<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"http://terminology.hl7.org/ValueSet/v2-0448\">http://terminology.hl7.org/ValueSet/v2-0448</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.10\">10</a><a name=\"XPN.10\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Name Validity Range</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.11\">11</a><a name=\"XPN.11\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ID.html\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Name Assembly Order<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"http://terminology.hl7.org/6.0.2/ValueSet-v2-0444.html\" title=\"http://terminology.hl7.org/ValueSet/v2-0444\">hl7VS-nameAssemblyOrder</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.12\">12</a><a name=\"XPN.12\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-DTM.html\">dateTime</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Effective Date</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.13\">13</a><a name=\"XPN.13\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-DTM.html\">dateTime</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Expiration Date</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.14\">14</a><a name=\"XPN.14\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Professional Suffix</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-XPN-definitions.html#XPN.15\">15</a><a name=\"XPN.15\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ST.html\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Called By</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://somewhere.org/fhir/uv/v2plus/ImplementationGuide/hl7.other.uv.v2plus"
}
]
}
}
],
"url" : "http://hl7.org/v2/StructureDefinition/XPN",
"version" : "0.0.0",
"name" : "XPN",
"title" : "HL7 v2 XPN Data Type",
"status" : "active",
"date" : "2024-11-08T13:58:48+00:00",
"publisher" : "HL7 International",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.org/Special/committees/v2mgmt"
}
]
}
],
"description" : "*Note:* Replaces PN data type as of v 2.3.\n\n*Internationalization Note:* In countries using ideographic or syllabic (phonetic) character sets, it is sometimes necessary to send the name in one or both of these formats, as well as an alphabetic format. The switching between the different character sets can be accomplished using a character set such as JIS X 0202 - ISO 2022 which provides an escape sequence for switching among different character sets and among single-byte and multi-byte character representations. When the name field is repeated, the different repetitions of the name may be represented by these different character sets. The details are as follows. (See also Section 2.9.2, “Escape sequences supporting multiple character sets for PN, XPN, XCN, XON, XAD, FT, ST and TX data types.â€)\n\nHL7 supports the following standards for Japanese characters:\n\nJIS X 0201 for ISO-IR 13 (Japanese Katakana)\n\nJIS X 0201 for ISO-IR 14 (Japanese Romaji)\n\nJIS X 0208 for ISO-IR 87 (Japanese Kanji, Hiragana and Katakana)\n\nJIS X 0212 for ISO-IR 159 (supplementary Japanese Kanji)\n\nHL7 supports the following standards for European characters:\n\nISO 8859 (1-9) for ISO-IR 100, 101, 109, 110, 144,127, 126, 138 and 148.\n\nCharacter sets are referenced in HL7 as ASCII, 8859/1,8859/2, ISO IR14, ISO IR87, and ISO IR159. DICOM uses codes laid out in ISO 2375, of the form 'ISO-IR xxx'. HL7 supports this naming as well, to facilitate interoperability.\n\nHL7 uses the Basic G0 Set of the International Reference Version of ISO 646:1990 (ISO IR-6) as the default character repertoire for character strings. This is a single-byte character set, identical to ASCII.\n\nEach repetition of a XPN, XON, XCN, or XAD field is assumed to begin with the default character set. If another character set is to be used, the HL7 defined escape sequence used to announce that character set must be at the beginning of the repetition, and the HL7 defined escape sequence used to start the default character set must be at the end of the repetition. Note also that several character sets may be intermixed within a single repetition as long as the repetition ends with a return to the default character set.\n\nAn application must specify which character sets it supports in the field _MSH-18 Character Sets_ and which character set handling scheme it supports in the field _MSH-20 Alternate Character Set Handling Scheme_. It is assumed that the sending and receiving applications are aware of how to map character set names (i.e., ISO-IR xxx) to escape sequences.\n\nFor example, in many Japanese messages there is a mix of Romaji (i.e., Roman characters), Katakana (phonetic representation of foreign words), Hiragana (phonetic representation of Japanese words) and Kanji (pictographs). Such a message would require 4 character sets be specified in the MSH.\n\nReferences for Internationalization of Name\n\n<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<table border=\"1\">\n<tr>\n<th> </th>\n<th>Reference </th>\n<th>Description</th>\n</tr>\n<tr>\n<td>1. </td>\n<td>“Understanding Japanese Information Processing” by Ken Lunde, O’Reilly Press </td>\n</tr>\n<tr>\n<td>2. </td>\n<td>NEMA PS3.5 - DICOM Part 5: Data Structure and Semantics </td>\n</tr>\n<tr>\n<td>3. </td>\n<td>ANSI X3.4:1986 </td>\n<td>ASCII character set</td>\n</tr>\n<tr>\n<td>4. </td>\n<td>ISO 646:1990 </td>\n<td>Information Processing - ISO 7-bit coded character set for information interchange</td>\n</tr>\n<tr>\n<td>5. </td>\n<td>ISO/IEC 2022:1994 </td>\n<td>Information Technology - Character code structure and extension techniques</td>\n</tr>\n<tr>\n<td>6. </td>\n<td>ISO 2375:1986 </td>\n<td>Data Processing - Procedure for the registration of escape sequences</td>\n</tr>\n<tr>\n<td>7. </td>\n<td>ISO 6429:1990 </td>\n<td>Information Processing - Control functions for 7-bit and 8-bit coded character sets</td>\n</tr>\n<tr>\n<td>8. </td>\n<td>ISO 8859 (1-9) </td>\n<td>Information Processing - 8-bit single-byte coded graphic character sets - parts 1-9</td>\n</tr>\n<tr>\n<td>9. </td>\n<td>ENV 41 503:1990 </td>\n<td>Information systems interconnection - European graphic character repertoires and their coding</td>\n</tr>\n<tr>\n<td>10. </td>\n<td>ENV 41 508:1990 </td>\n<td>Information systems interconnection - East European graphic character repertoires and their coding</td>\n</tr>\n<tr>\n<td>11. </td>\n<td>JIS X 0201-1976 </td>\n<td>Code for Information Exchange</td>\n</tr>\n<tr>\n<td>12. </td>\n<td>JIS X 0212-1990 </td>\n<td>Code of the supplementary Japanese Graphic Character set for information interchange</td>\n</tr>\n<tr>\n<td>13. </td>\n<td>JIS X 0208-1990 </td>\n<td>Code for the Japanese Graphic Character set for information interchange</td>\n</tr>\n<tr>\n<td>14. </td>\n<td>RFC 1468 </td>\n<td>Japanese Character Encoding for Internet Messages</td>\n</tr>\n</table>\n\n\nCharacter Repertoires supported by DICOM are defined in Part 5, section 6.1. The DICOM Standard is available free on the Internet at http://medical.nema.org/[_http://medical.nema.org/_].\n\n*Examples of names requiring only one iteration of the field where the XPN is applied:*\n\nExample 1: Adam A. Everyman III PhD\n\n|Everyman^Adam^A^III^DR^^L^^^^^^^PHD|\n\nExample 2: Ludwig van Beethoven\n\n|Beethoven&van^Ludwig^^^^^L|\n\nExample 3: Hermann Egon Mayer zur alten Schildesche\n\n|Mayer^Hermann^Egon^zur alten Schildesche|\n\nExample 4: Sister Margot\n\n|^Margot^^^Sister^^C|\n\nExample 5: Dr Harold Henry Hippocrates AO. MBBS. ASCTS. A physician who holds an Honorarium, an academic degree and a board certificate. Professional suffixes are displayed as concatenated. (AO = Order of Australia (Honorarium), MBBS = Bachelor of Medicine and Bachelor of Surgery, ASCTS = Australian Society of Cardiothoracic Surgeons\n\n|Hippocrates^Harold^Henry^^^^L^^^^^^^AO.MBBS.ASCTS|\n\nExample 6: Nancy N. Nightingale, RN, PHN, BSN, MSN. A registered nurse who is a Public Health Nurse with 2 academic degrees, BSN and MSN.\n\n|Nightingale^Nancy^N^^^^^^^^^^^RN, PHN, BSN, MSN|\n\nExample 7: H.Horrace Helper Jr., RN, CNP. A registered nurse who is a certified nurse practitioner.\n\n|Helper^H^Horrace^Jr^^^^^^^^^^ RN, CNP|\n\nExample 8: Mevrouw Irma Jongeneel de Haas.\n\nAn individual whose birth name (geboortenaam) is de Haas and whose partner's name is Jongeneel.\n\n| Jongeneel-de Haas&de&Haas&&Jongeneel^Irma^^^Mevrouw^^L |\n\n*Examples of names requiring more than one iteration of the field where the XPN is applied:*\n\nExample 9: Herr Prof. Dr. med. Joachim W. Dudeck\n\n|Dudeck^Joachim^W.^^Dr.med.^^L^^^^^^^ MD ~Dudeck^J.W.^^^Herr Prof.Dr.^^D|\n\nExample 10: Herr Dr. Otto Graf Lambsdorff mdB a.D.\n\nAccording to German law “Adelstitel†like “Graf†or “Baron†belongs to the family name and therefore must be encoded in the family name field separated by blanks.\n\n|Graf Lambsdorff&Graf&Lambsdorff^Otto^^^Dr.^^L~Graf Lambsdorff&Graf&Lambsdorff^Otto^^mdB a.D.^Herr Dr.^^D|\n\nExample 11: Walter Kemper genannt (named) Mölleken\n\n|Kemper^Walter^^^^^L~Mölleken^Walter^^^^^A|\n\nExample 12: Herr Dr. med. Dr. h.c. Egon Maier\n\n|Maier^Egon^^^Dr.med. Dr.h.c.^^L^^^^^^^MD~Maier^Egon^^^Herr Dr.med. Dr.h.c^^D|\n\nExample 13: Herr Dipl.Ing. Egon Maier\n\n|Maier^Egon^^^^^L^^^^^^^ DIPL~Maier^Egon^^^Herr Dipl.Ing.^^D|\n\nExample 14: Frau Gerda Müller geb. Maier, verheiratet seit 16.2.2000\n\n|Müller^Gerda^^^Frau^^L^^^^^20000216~Maier^Gerda^^^Frau^^M|\n\nExample 15: President Adam A Everyman III, president from 1997 until 2001, aka Sonny Everyman\n\n|Everyman^Adam^A.^III^President^^L~^^^^Mr. President^^D^^^^^19970816^20010320~Everyman^Sonny^^^^^A|\n\nExample 16: Michio Kimura\n\nThis example doesn’t use title and degrees, but shows the repetition of this name for different purposes. The first iteration is the legal name in Kanji; the second, Katakana; the third, alphabetic.\n\nimage:extracted-media/media/image1.png[extracted-media/media/image1]",
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/v2/StructureDefinition/XPN",
"baseDefinition" : "http://hl7.org/v2/StructureDefinition/v2-complex-data-type",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "XPN",
"path" : "XPN",
"short" : "extended person name",
"definition" : "Base definition for all types defined in FHIR type system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "XPN.1",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "RE"
}
],
"path" : "XPN.1",
"short" : "Family Name",
"min" : 1,
"max" : "1",
"base" : {
"path" : "XPN.1",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/FN"
}
]
},
{
"id" : "XPN.2",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 30
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.2",
"short" : "Given Name",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.2",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.3",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 30
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.3",
"short" : "Second and Further Given Names or Initials Thereof",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.3",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.4",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 20
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.4",
"short" : "Suffix",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.4",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.5",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 20
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.5",
"short" : "Prefix",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.5",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.6",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "W"
}
],
"path" : "XPN.6",
"short" : "Degree",
"base" : {
"path" : "XPN.6",
"min" : 0
}
},
{
"id" : "XPN.7",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "min",
"valueInteger" : 1
},
{
"url" : "max",
"valueInteger" : 5
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-length"
}
],
"path" : "XPN.7",
"short" : "Name Type Code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.7",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0200"
}
},
{
"id" : "XPN.8",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "min",
"valueInteger" : 1
},
{
"url" : "max",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-length"
}
],
"path" : "XPN.8",
"short" : "Name Representation Code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.8",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0465"
}
},
{
"id" : "XPN.9",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
}
],
"path" : "XPN.9",
"short" : "Name Context",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.9",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/CWE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0448"
}
},
{
"id" : "XPN.10",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "W"
}
],
"path" : "XPN.10",
"short" : "Name Validity Range",
"base" : {
"path" : "XPN.10",
"min" : 0
}
},
{
"id" : "XPN.11",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "min",
"valueInteger" : 1
},
{
"url" : "max",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-length"
}
],
"path" : "XPN.11",
"short" : "Name Assembly Order",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.11",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0444"
}
},
{
"id" : "XPN.12",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
}
],
"path" : "XPN.12",
"short" : "Effective Date",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.12",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/DTM"
}
]
},
{
"id" : "XPN.13",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
}
],
"path" : "XPN.13",
"short" : "Expiration Date",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.13",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/DTM"
}
]
},
{
"id" : "XPN.14",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 199
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.14",
"short" : "Professional Suffix",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.14",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.15",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 30
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.15",
"short" : "Called By",
"min" : 0,
"max" : "1",
"base" : {
"path" : "XPN.15",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "XPN",
"path" : "XPN",
"short" : "extended person name",
"min" : 0,
"max" : "*"
},
{
"id" : "XPN.1",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "RE"
}
],
"path" : "XPN.1",
"short" : "Family Name",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/FN"
}
]
},
{
"id" : "XPN.2",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 30
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.2",
"short" : "Given Name",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.3",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 30
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.3",
"short" : "Second and Further Given Names or Initials Thereof",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.4",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 20
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.4",
"short" : "Suffix",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.5",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 20
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.5",
"short" : "Prefix",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.6",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "W"
}
],
"path" : "XPN.6",
"short" : "Degree"
},
{
"id" : "XPN.7",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "min",
"valueInteger" : 1
},
{
"url" : "max",
"valueInteger" : 5
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-length"
}
],
"path" : "XPN.7",
"short" : "Name Type Code",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0200"
}
},
{
"id" : "XPN.8",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "min",
"valueInteger" : 1
},
{
"url" : "max",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-length"
}
],
"path" : "XPN.8",
"short" : "Name Representation Code",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0465"
}
},
{
"id" : "XPN.9",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
}
],
"path" : "XPN.9",
"short" : "Name Context",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/CWE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0448"
}
},
{
"id" : "XPN.10",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "W"
}
],
"path" : "XPN.10",
"short" : "Name Validity Range"
},
{
"id" : "XPN.11",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "min",
"valueInteger" : 1
},
{
"url" : "max",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-length"
}
],
"path" : "XPN.11",
"short" : "Name Assembly Order",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ID"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0444"
}
},
{
"id" : "XPN.12",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
}
],
"path" : "XPN.12",
"short" : "Effective Date",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/DTM"
}
]
},
{
"id" : "XPN.13",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
}
],
"path" : "XPN.13",
"short" : "Expiration Date",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/DTM"
}
]
},
{
"id" : "XPN.14",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 199
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.14",
"short" : "Professional Suffix",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
},
{
"id" : "XPN.15",
"extension" : [
{
"url" : "http://hl7.org/v2/StructureDefinition/v2-optionality",
"valueCode" : "O"
},
{
"extension" : [
{
"url" : "length",
"valueInteger" : 30
},
{
"url" : "noTruncate",
"valueBoolean" : true
}
],
"url" : "http://hl7.org/v2/StructureDefinition/v2-conformance-length"
}
],
"path" : "XPN.15",
"short" : "Called By",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/v2/StructureDefinition/ST"
}
]
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.